home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr14 / maped6.zip / MAPEDIT.DOC < prev    next >
Text File  |  1993-05-15  |  8KB  |  192 lines
  1.  
  2.           *************************************************
  3.           *    MapEdit 6.0  - Wolfenstein Map Editor      *
  4.           *************************************************
  5.  
  6.     Ver 6.0  - Dave Huntoon Modification (Help, Copy, Paste, Exchange,
  7.                                           Write and Read)
  8.     Ver 5.0  - Bryan Baker  Modification (Display of critical statistics)
  9.     Ver 4.1a - Dave Huntoon Modification (Spear of Destiny compatibility)
  10.     Ver 4.1  - (c) 1992 Bill Kirby
  11.  
  12.  
  13. To use MapEdit, unpack the archive into the directory where Wolfenstein
  14. is installed.  Type MAPEDIT to start the editor.
  15.  
  16.  
  17. Key functions:
  18.  
  19. arrows - select level to view
  20.      Q - quit (you will be prompted to save)
  21.      C - clear level (grey brick around the outside inside filled with 
  22.                       selected map value)
  23.      O - toggle object display
  24.      F - toggle floor display
  25.      S - toggle between Statistics and Help display
  26.      M - Memorize present map
  27.      T - Transfer memorized map with present map
  28.      E - Exchange memorized map with present map
  29.      W - Write present map to a file named FLOOR.OUT
  30.      R - Read into clipboard FLOOR.OUT
  31.      V - Display MapEdit version number
  32.  
  33. *** NOTE:
  34. *** If any of the commands in the Help display flash Red then there was an
  35. *** error executing the command.  See command description below.
  36.  
  37. Map window:
  38.  
  39. Whenever the mouse is in the map window, the map and object data for the
  40. selected square will be displayed beneath the window.  Clicking the mouse
  41. will change either the map or object data to the currently selected item.
  42.  
  43.  
  44. Legend window:
  45.  
  46. The window on the right side of the screen displays the map/object legend.
  47. Clicking on UP/DOWN scrolls through the list.  Clicking on MAP/OBJ switches
  48. between the map and object lists.  Clicking on an item in the list makes
  49. it the "current" item.
  50.  
  51. After each guard, there is a 3 character description which specifies
  52. what level the guard is, whether they are moving or stationary, and
  53. what direction they are facing/walking.  For example, "1/S/E" means
  54. a level 1 guard, stationary, facing east.
  55.  
  56.  
  57. Memorize, Transfer and Exchange functions:
  58.  
  59. ***********************************************************************
  60. ***** Note: Always make backups of your gamemap files before      *****
  61. ***** using these commands. Save your MAPHEAD.WL1 and MAPTEMP.WL1 *****
  62. ***** or MAPHEAD.WL6 and GAMEMAPS.WL6 or MAPHEAD.SOD and          *****
  63. ***** GAMEMAPS.SOD.                                               *****
  64. ***********************************************************************      
  65. With these operations you can move maps from one floor to another.  If you
  66. want to copy a floor, move to the floor you want to copy and press the 'M'
  67. key.  The Memorize line in the help display will turn yellow indicating that
  68. you have a stored floor in the clipboard.  This will now stay yellow for the
  69. rest of the session because there will always be something stored.  You can
  70. now Transfer (Paste) the Memorized floor wherever you want.  Move to the
  71. floor where you want the stored floor to be and either press 'T' to Transfer
  72. the stored floor on top of the presently displayed floor or press 'E' to
  73. exchange the displayed floor with the Memorized floor.  The Exchange function
  74. allows you to easily move the floors up or down a level.  If the Memorize line
  75. in the Help display is not yellow (nothing stored) these functions won't work.
  76. They will flash red for this case.
  77.  
  78. If you use the Transfer operation you will lose the floor that you copied the
  79. Memorized floor on top of.  If the Statistics display is on the display will
  80. flip to the help display during the Memorize, Transfer and Exchange operations
  81. and then flip back to the statistics display.
  82.  
  83.  
  84. Write and Read functions:
  85.  
  86. If you want to share floor maps or create floor maps with a group or if 
  87. you have designed a favorite floor in one version of Wolfenstein and would
  88. like to move it to a different version you can now do it with these functions.
  89. MapEdit was designed to operate from one directory and has no directory
  90. features nor keyboard/display functions built in.  It will take a little
  91. extra work to implement copying and pasting from one map file to another from
  92. within MapEdit.  To implement this feature quickly I decided to implement
  93. the exporting and importing of maps by file.  The file is predefined as
  94. FLOOR.OUT and you can only export/import one floor at a time.  You have to
  95. have two directories with MapEdit and the gamemap files you want to transfer
  96. the floors between or you must move the gamemap files in and out of the
  97. working directory.  I know this can be a pain but this was the easiest way
  98. without requiring major changes to the MapEdit program.  If there is a big
  99. enough demand to implement an easier interface then I'll work on it.
  100. To export a floor you run MapEdit on the gamemap/maphead files you want to 
  101. export from.  You move to the floor that you want and press the 'W' key and
  102. the displayed floor is written to 'FLOOR.OUT'.  You now quit MapEdit and copy
  103. the FLOOR.OUT file into the directory that has the gamemap/maphead files you
  104. want to import the floor into.  Run MapEdit and press 'R' to read into the
  105. clipboard the file FLOOR.OUT.  Now move to the floor where you want your
  106. imported floor and press 'T' to paste it or press 'E' to exchange it with
  107. the displayed floor.  You copy FLOOR.OUT into the directory containing the
  108. gamemaps you want to import the floor into or move the gamemaps into the same
  109. directory.  An error message will be displayed if there was a problem reading
  110. or writing the file.
  111.  
  112. A major advantage of exporting/importing by file is that you now can share
  113. your floors with others without having to give them the whole gamemap/maphead
  114. files.  All you have to do is give them the FLOOR.OUT file of your favorite
  115. design and they can read it into theirs.
  116.  
  117.  
  118. Clear Level:
  119.  
  120. Pressing the 'C' key will Clear the current floor placing grey brick on the
  121. outside edge and filling the inside with the selected map value.  Before you
  122. clear the display select the map value you want to fill with then press 'C'.
  123. You can fill with any map value.  If the last item you selected was an Object
  124. then if you Clear before selecting a map value the clear function will fill
  125. using a floor value of '8C'.
  126.  
  127.  
  128. MAPDATA.DEF and OBJDATA.DEF:
  129.  
  130. If you figure out a new object, you can add it's description to the
  131. object/map list by editing the MAPDATA.DEF or OBJDATA.DEF file.
  132. Each line in the file contains 3 items:
  133.  
  134. 0000 0000 Objectname
  135.  
  136. The first four digits are HEX for the object number.  Right now, even
  137. though their are 4 digits, you can only put objects from 0000-00ff in.
  138.  
  139. ** Note version 4.1a allows up to 0116.
  140.  
  141. The second four digits define how the object will look in the map.
  142. The first two digits are the primary/secondary colors.  The third
  143. digit is the graphic type, and the fourth digit is the character
  144. string to use if the graphic type is "text".
  145.  
  146. Colors:
  147.    0 - black
  148.    1 - blue
  149.    2 - green
  150.    3 - cyan
  151.    4 - red
  152.    5 - magenta
  153.    6 - brown
  154.    7 - light grey
  155.    8 - dark grey
  156.    9 - light blue
  157.    a - light green
  158.    b - light cyan
  159.    c - light red
  160.    d - light magenta
  161.    e - yellow
  162.    f - white
  163.  
  164. Graphic types:
  165.  
  166.    0 - text (uses fourth character of graphic definition)
  167.    1 - solid box
  168.    2 - checkered
  169.    3 - solid box (primary) with decoration (secondary)
  170.    4 - checkered box (primary) with decoration (secondary)
  171.    5 - large filled circle (primary) with smaller circle (secondary)
  172.    6 - horizontal bar
  173.    7 - vertical bar
  174.    8 - two color box (used for landscape view)
  175.    9 - single pixel centered
  176.    a - 3x3 pixel block
  177.    b - 3x5 pixel block
  178.    c -
  179.    d - X (primary)
  180.    e - rectangle
  181.    f - arrow  (secondary color indicates direction: 0=n,1=ne,2=e,3=se,
  182.                                                     4=s,5=sw,6=w,7=nw)
  183.  
  184.  
  185. ACKNOWLEDGMENTS
  186.  
  187.    This program would not have been possible without Paul (Hosko) Hosken,
  188. author of WMAP, who figured out the original map file formats.
  189.  
  190. Thanks Hosko!
  191.  
  192.